MarkLogic Server 11.0 Product Documentation
GET /manage/v2/clusters/{id|name}/properties

Summary

This resource address returns the modifiable properties of the named foreign cluster. The foreign cluster can be identified either by id or name.

URL Parameters
format	The format of the returned data. Can be either `json` or `xml` (default). This parameter overrides the Accept header if both are present.

Request Headers
Accept	The expected MIME type of the returned data. If the `format` parameter is present, it takes precedence over the Accept header.
Content-type	The MIME type of the data in the request body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response Headers
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response

Upon success, MarkLogic Server returns status code 200 (OK). A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

foreign-cluster-id

The ID of the foreign cluster.

foreign-cluster-name

The name of the foreign cluster.

xdqp-timeout

The XDQP protocol timeout, in seconds.

host-timeout

The host response timeout, in seconds.

foreign-ssl-certificate

The SSL certificate for the foreign cluster.

xdqp-ssl-enabled

Whether or not SSL is enabled for XDQP.

xdqp-ssl-allow-sslv3

Whether or not SSLv3 is allowed for XDQP (Deprecated).

xdqp-ssl-allow-tls

Whether or not TLS is allowed for XDQP.

xdqp-ssl-ciphers

A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)

foreign-bootstrap-hosts

Information about foreign hosts.

This is a complex structure with the following children:

foreign-bootstrap-host

Information related to a particular foreign host.

This is a complex structure with the following children:

foreign-host-id: The ID of the foreign host.
foreign-host-name: The name of the foreign host.
foreign-connect-port: The distributed protocol client socket connect internet port number.

foreign-protocol

foreign protocol.

Example